<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ClassWrapper xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/com/googlecode/transloader/ClassWrapper.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> com.googlecode.transloader;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a name="4" href="#4">4</a>   <strong class="jxr_keyword">import</strong> java.util.List;
<a name="5" href="#5">5</a>   
<a name="6" href="#6">6</a>   <strong class="jxr_keyword">import</strong> org.apache.commons.lang.ClassUtils;
<a name="7" href="#7">7</a>   
<a name="8" href="#8">8</a>   <em class="jxr_javadoccomment">/**</em>
<a name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> * The wrapper appropriate for wrapping around all &lt;code&gt;Class&lt;/code&gt;es from potentially foreign</em>
<a name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;ClassLoader&lt;/code&gt;s.</em>
<a name="11" href="#11">11</a>  <em class="jxr_javadoccomment"> * </em>
<a name="12" href="#12">12</a>  <em class="jxr_javadoccomment"> * @author Jeremy Wales</em>
<a name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> */</em>
<a name="14" href="#14">14</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../com/googlecode/transloader/ClassWrapper.html">ClassWrapper</a> {
<a name="15" href="#15">15</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Class wrappedClass;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="18" href="#18">18</a>  <em class="jxr_javadoccomment">	 * Constructs a new &lt;code&gt;ClassWrapper&lt;/code&gt; around the given &lt;code&gt;Class&lt;/code&gt;. Note that using</em>
<a name="19" href="#19">19</a>  <em class="jxr_javadoccomment">	 * implementation of {@link Transloader} is the recommended way to produce these.</em>
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment">	 * @param classToWrap the &lt;code&gt;Class&lt;/code&gt; to wrap</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="23" href="#23">23</a>  	<strong class="jxr_keyword">public</strong> <a href="../../../com/googlecode/transloader/ClassWrapper.html">ClassWrapper</a>(Class classToWrap) {
<a name="24" href="#24">24</a>  		wrappedClass = classToWrap;
<a name="25" href="#25">25</a>  	}
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment">	 * Indicates whether or not &lt;code&gt;null&lt;/code&gt; is what is wrapped.</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment">	 * @return true if the wrapped "Class" is actually &lt;code&gt;null&lt;/code&gt;</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="32" href="#32">32</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isNull() {
<a name="33" href="#33">33</a>  		<strong class="jxr_keyword">return</strong> wrappedClass == <strong class="jxr_keyword">null</strong>;
<a name="34" href="#34">34</a>  	}
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment">	 * Provides direct access to the wrapped &lt;code&gt;Class&lt;/code&gt;.</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment">	 * @return the actual wrapped &lt;code&gt;Class&lt;/code&gt; without any wrapping</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="41" href="#41">41</a>  	<strong class="jxr_keyword">public</strong> Class getUnwrappedSelf() {
<a name="42" href="#42">42</a>  		<em class="jxr_comment">// TODO test Class getUnwrappedSelf() or remove</em>
<a name="43" href="#43">43</a>  		<strong class="jxr_keyword">return</strong> wrappedClass;
<a name="44" href="#44">44</a>  	}
<a name="45" href="#45">45</a>  
<a name="46" href="#46">46</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">	 * Indicates whether or not the wrapped &lt;code&gt;Class&lt;/code&gt; is assignable to a &lt;code&gt;Class&lt;/code&gt; with the given</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">	 * name. It takes a parameter of type &lt;code&gt;String&lt;/code&gt; instead of &lt;code&gt;Class&lt;/code&gt; so that the test can be</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">	 * performed for &lt;code&gt;Class&lt;/code&gt;es that do not have an equivalent in the caller's &lt;code&gt;ClassLoader&lt;/code&gt;.</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">	 * @param typeName the name of the type to check against</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment">	 * @return true if the wrapped &lt;code&gt;Class&lt;/code&gt; is assignable to a &lt;code&gt;Class&lt;/code&gt; with the given name</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="54" href="#54">54</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAssignableTo(String typeName) {
<a name="55" href="#55">55</a>  		Assert.isNotNull(typeName);
<a name="56" href="#56">56</a>  		<strong class="jxr_keyword">return</strong> classIsAssignableToType(wrappedClass, typeName);
<a name="57" href="#57">57</a>  	}
<a name="58" href="#58">58</a>  
<a name="59" href="#59">59</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">	 * Loads the &lt;code&gt;Class&lt;/code&gt; with the given name from the given &lt;code&gt;ClassLoader&lt;/code&gt;.</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">	 * @param className the name of the &lt;code&gt;Class&lt;/code&gt;</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">	 * @param classLoader the &lt;code&gt;ClassLoader&lt;/code&gt; with which to load it</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">	 * @return the &lt;code&gt;Class&lt;/code&gt; with the given name loaded from the given &lt;code&gt;ClassLoader&lt;/code&gt;</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">	 * @throws TransloaderException if the &lt;code&gt;Class&lt;/code&gt; cannot be found in the given &lt;code&gt;ClassLoader&lt;/code&gt;</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="67" href="#67">67</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Class getClass(String className, ClassLoader classLoader) {
<a name="68" href="#68">68</a>  		Assert.areNotNull(className, classLoader);
<a name="69" href="#69">69</a>  		<strong class="jxr_keyword">try</strong> {
<a name="70" href="#70">70</a>  			<strong class="jxr_keyword">return</strong> ClassUtils.getClass(classLoader, className, false);
<a name="71" href="#71">71</a>  		} <strong class="jxr_keyword">catch</strong> (ClassNotFoundException e) {
<a name="72" href="#72">72</a>  			<em class="jxr_comment">// TODO test ClassNotFoundException</em>
<a name="73" href="#73">73</a>  			<strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../com/googlecode/transloader/TransloaderException.html">TransloaderException</a>(
<a name="74" href="#74">74</a>  					<span class="jxr_string">"Unable to load Class '"</span> + className + <span class="jxr_string">"' from ClassLoader '"</span> + classLoader + <span class="jxr_string">"'."</span>, e);
<a name="75" href="#75">75</a>  		}
<a name="76" href="#76">76</a>  	}
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">	 * Loads the &lt;code&gt;Class&lt;/code&gt;es with the given names from the given &lt;code&gt;ClassLoader&lt;/code&gt;.</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">	 * @param classNames the names of the &lt;code&gt;Class&lt;/code&gt;es</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">	 * @param classLoader the &lt;code&gt;ClassLoader&lt;/code&gt; with which to load them</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">	 * @return the &lt;code&gt;Class&lt;/code&gt;es with the given names loaded from the given &lt;code&gt;ClassLoader&lt;/code&gt;</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">	 * @throws TransloaderException if even one of the &lt;code&gt;Class&lt;/code&gt;es cannot be found in the given</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">	 *             &lt;code&gt;ClassLoader&lt;/code&gt;</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="87" href="#87">87</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Class[] getClasses(String[] classNames, ClassLoader classLoader) {
<a name="88" href="#88">88</a>  		Assert.areNotNull(classNames, classLoader);
<a name="89" href="#89">89</a>  		Class[] classes = <strong class="jxr_keyword">new</strong> Class[classNames.length];
<a name="90" href="#90">90</a>  		<strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; classes.length; i++) {
<a name="91" href="#91">91</a>  			classes[i] = getClass(classNames[i], classLoader);
<a name="92" href="#92">92</a>  		}
<a name="93" href="#93">93</a>  		<strong class="jxr_keyword">return</strong> classes;
<a name="94" href="#94">94</a>  	}
<a name="95" href="#95">95</a>  
<a name="96" href="#96">96</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> classIsAssignableToType(Class rootClass, String typeName) {
<a name="97" href="#97">97</a>  		List allClasses = <strong class="jxr_keyword">new</strong> ArrayList();
<a name="98" href="#98">98</a>  		allClasses.add(rootClass);
<a name="99" href="#99">99</a>  		allClasses.addAll(ClassUtils.getAllSuperclasses(rootClass));
<a name="100" href="#100">100</a> 		allClasses.addAll(ClassUtils.getAllInterfaces(rootClass));
<a name="101" href="#101">101</a> 		<strong class="jxr_keyword">return</strong> ClassUtils.convertClassesToClassNames(allClasses).contains(typeName);
<a name="102" href="#102">102</a> 	}
<a name="103" href="#103">103</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

